<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Namespace: facebook</title>
    
    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">
    
    <h1 class="page-title">Namespace: facebook</h1>
    
    



<section>
    
<header>
    <h2>
    facebook
    </h2>
    
</header>  

<article>
    <div class="container-overview">
    
    
    
        
        
        
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="FacebookAPI.js.html">FacebookAPI.js</a>, <a href="FacebookAPI.js.html#line6">line 6</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

        
        
    
    </div>
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        <h3 class="subsection-title">Methods</h3>
        
        <dl>
            
<dt>
    <h4 class="name" id="createAlbum"><span class="type-signature">&lt;static> </span>createAlbum<span class="signature">(data)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Create an album.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>data</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>
            
            
            
            
            
            <td class="description last"></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="FacebookAPI.js.html">FacebookAPI.js</a>, <a href="FacebookAPI.js.html#line506">line 506</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
    <h5>Fires:</h5>
    <ul>
        <li>facebook.Events.event:ALBUM_COMPLETE</li>
    
        <li>facebook.Events.event:ALBUM_ERROR</li>
    </ul>
    

    

    
    
    
    
    
    
    
        <h5>Examples</h5>
        
    <pre class="prettyprint"><code>var data = {title:"Sample title",description:"Sample description"};		facebook.createAlbum(data);facebook.on(facebook.Events.ALBUM_COMPLETE, onComplete);facebook.on(facebook.Events.ALBUM_ERROR, onError);</code></pre>

    <pre class="prettyprint"><code>onError:function(){console.log("error");}onComplete:function(){console.log("album created");}</code></pre>

    
</dd>

        
            
<dt>
    <h4 class="name" id="invite"><span class="type-signature">&lt;static> </span>invite<span class="signature">(data)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Show Facebook Dialog to invite friends (available only on canvas Application)
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>data</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>
            
            
            
            
            
            <td class="description last"></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="FacebookAPI.js.html">FacebookAPI.js</a>, <a href="FacebookAPI.js.html#line729">line 729</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
    <h5>Fires:</h5>
    <ul>
        <li>facebook.Events.event:INVITE_COMPLETE</li>
    
        <li>facebook.Events.event:INVITE_ERROR</li>
    </ul>
    

    

    
    
    
    
    
    
    
        <h5>Examples</h5>
        
    <pre class="prettyprint"><code>var data = {msg:"A message"};	facebook.invite(data);facebook.on(facebook.Events.INVITE_COMPLETE, onComplete);facebook.on(facebook.Events.INVITE_ERROR, onError);</code></pre>

    <pre class="prettyprint"><code>onError:function(){console.log("error");}onComplete:function(){console.log("invitation send");}</code></pre>

    
</dd>

        
            
<dt>
    <h4 class="name" id="setStatutMessage"><span class="type-signature">&lt;static> </span>setStatutMessage<span class="signature">(data)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Post a message on your timeline.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>data</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>
            
            
            
            
            
            <td class="description last"></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="FacebookAPI.js.html">FacebookAPI.js</a>, <a href="FacebookAPI.js.html#line407">line 407</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
    <h5>Fires:</h5>
    <ul>
        <li>facebook.Events.event:SET_STATUT_MESSAGE_COMPLETE</li>
    
        <li>facebook.Events.event:SET_STATUT_MESSAGE_ERROR</li>
    </ul>
    

    

    
    
    
    
    
    
    
        <h5>Examples</h5>
        
    <pre class="prettyprint"><code>var data = {message:"Sample text",picture:"http://greenlime.fr/images/samplePicture.png",link:"http://www.greenlime.fr",name:"Sample name",caption:"Send by Application",description:"Sample Description",source:null,place:null,tags:null};		facebook.setStatutMessage(data);facebook.on(facebook.Events.SET_STATUT_MESSAGE_COMPLETE, onComplete);facebook.on(facebook.Events.SET_STATUT_MESSAGE_ERROR, onError);</code></pre>

    <pre class="prettyprint"><code>onError:function(){console.log("error");}onComplete:function(){console.log("statut message send");}</code></pre>

    
</dd>

        
            
<dt>
    <h4 class="name" id="share"><span class="type-signature">&lt;static> </span>share<span class="signature">(data)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Show Facebook Dialog to share application (available only on canvas Application)
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>data</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>
            
            
            
            
            
            <td class="description last"></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="FacebookAPI.js.html">FacebookAPI.js</a>, <a href="FacebookAPI.js.html#line670">line 670</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
    <h5>Fires:</h5>
    <ul>
        <li>facebook.Events.event:SHARE_COMPLETE</li>
    
        <li>facebook.Events.event:SHARE_ERROR</li>
    </ul>
    

    

    
    
    
    
    
    
    
        <h5>Examples</h5>
        
    <pre class="prettyprint"><code>var data = {titre:"Facebook Dialogs",caption:"Reference Documentation",desc:"Dialogs provide a simple, consistent interface for applications to interface with users.",link:"https://developers.facebook.com/docs/reference/dialogs/",picture:"http://fbrell.com/f8.jpg"};		facebook.share(data);facebook.on(facebook.Events.SHARE_COMPLETE, onComplete);facebook.on(facebook.Events.SHARE_ERROR, onError);</code></pre>

    <pre class="prettyprint"><code>onError:function(){console.log("error");}onComplete:function(){console.log("picture uploaded");}</code></pre>

    
</dd>

        
            
<dt>
    <h4 class="name" id="uploadPicture"><span class="type-signature">&lt;static> </span>uploadPicture<span class="signature">(data)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Upload a photo on your timeline or album specified.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>data</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>
            
            
            
            
            
            <td class="description last"></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="FacebookAPI.js.html">FacebookAPI.js</a>, <a href="FacebookAPI.js.html#line588">line 588</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
    <h5>Fires:</h5>
    <ul>
        <li>facebook.Events.event:UPLOAD_PICTURE_COMPLETE</li>
    
        <li>facebook.Events.event:UPLOAD_PICTURE_ERROR</li>
    </ul>
    

    

    
    
    
    
    
    
    
        <h5>Examples</h5>
        
    <pre class="prettyprint"><code>var data = {src:"Sample url",description:"Sample description",albumId:"albumID"};		facebook.uploadPicture(data);facebook.on(facebook.Events.UPLOAD_PICTURE_COMPLETE, onComplete);facebook.on(facebook.Events.UPLOAD_PICTURE_ERROR, onError);</code></pre>

    <pre class="prettyprint"><code>onError:function(){console.log("error");}onComplete:function(){console.log("picture uploaded");}</code></pre>

    
</dd>

        </dl>
    
    
    
    
    
</article>

</section>  




</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Collections.facebook.Collections.Albums.html">facebook.Collections.Albums</a></li><li><a href="Collections.facebook.Collections.Friends.html">facebook.Collections.Friends</a></li><li><a href="Models.facebook.Models.Me.html">facebook.Models.Me</a></li><li><a href="Models.facebook.Models.Permissions.html">facebook.Models.Permissions</a></li></ul><h3>Namespaces</h3><ul><li><a href="Collections.html">Collections</a></li><li><a href="Events.html">Events</a></li><li><a href="facebook.html">facebook</a></li><li><a href="Models.html">Models</a></li></ul>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a> on Fri Sep 20 2013 16:51:48 GMT+0200 (CEST)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>